<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="adsense_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a> . <a href="adsense_v2.accounts.adclients.html">adclients</a> . <a href="adsense_v2.accounts.adclients.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about the selected custom channel.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the custom channels available in an ad client.</p>
<p class="toc_element">
  <code><a href="#listLinkedAdUnits">listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the ad units available for a custom channel.</p>
<p class="toc_element">
  <code><a href="#listLinkedAdUnits_next">listLinkedAdUnits_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.

Args:
  parent: string, Required. The ad client to create a custom channel under. Format: accounts/{account}/adclients/{adclient} (required)
  body: object, The request body.
    The object takes the form of:

{ # Representation of a custom channel.
  &quot;active&quot;: True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the custom channel.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a custom channel.
  &quot;active&quot;: True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the custom channel.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.

Args:
  name: string, Required. Name of the custom channel to delete. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets information about the selected custom channel.

Args:
  name: string, Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a custom channel.
  &quot;active&quot;: True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the custom channel.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the custom channels available in an ad client.

Args:
  parent: string, Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient} (required)
  pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
  pageToken: string, A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response definition for the custom channel list rpc.
  &quot;customChannels&quot;: [ # The custom channels returned in this list response.
    { # Representation of a custom channel.
      &quot;active&quot;: True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the custom channel.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
      &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
}</pre>
</div>

<div class="method">
    <code class="details" id="listLinkedAdUnits">listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the ad units available for a custom channel.

Args:
  parent: string, Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
  pageToken: string, A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response definition for the ad units linked to a custom channel list rpc.
  &quot;adUnits&quot;: [ # The ad units returned in the list response.
    { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
      &quot;contentAdsSettings&quot;: { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
        &quot;size&quot;: &quot;A String&quot;, # Required. Size of the ad unit. e.g. &quot;728x90&quot;, &quot;1x3&quot; (for responsive ad units).
        &quot;type&quot;: &quot;A String&quot;, # Required. Type of the ad unit.
      },
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the ad unit, as provided when the ad unit was created.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
      &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
      &quot;state&quot;: &quot;A String&quot;, # Required. State of the ad unit.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
}</pre>
</div>

<div class="method">
    <code class="details" id="listLinkedAdUnits_next">listLinkedAdUnits_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.

Args:
  name: string, Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  body: object, The request body.
    The object takes the form of:

{ # Representation of a custom channel.
  &quot;active&quot;: True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the custom channel.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}

  updateMask: string, The list of fields to update. If empty, a full update is performed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a custom channel.
  &quot;active&quot;: True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the custom channel.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  &quot;reportingDimensionId&quot;: &quot;A String&quot;, # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}</pre>
</div>

</body></html>